/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 - 2008 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
/**
 * 
 */
package com.genia.toolbox.projects.csv.business.util;

import java.util.List;
import java.util.Locale;

/**
 * interface for utility methods needed for csv importation data related to
 * enumerations.
 */
public interface EnumerationUtils
{

  /**
   * get the corresponding messages for all instances of the given enum for the
   * specified locale.
   * 
   * @param <T>
   *          the type of the enum
   * @param locale
   *          the {@link Locale} to consider
   * @param classz
   *          the {@link Class} of the enum
   * @return a {@link List} of string message in the concerned language
   */
  public <T extends Enum<T>> List<String> getAllMessageValues(Locale locale, Class<T> classz);



  /**
   * get the corresponding enum instance for the given locale and the string
   * message value in the concerned language.
   * 
   * @param <T>
   *          the type of the enum
   * @param locale
   *          the {@link Locale} to consider
   * @param classz
   *          the {@link Class} of the enum
   * @param messageValue
   *          the string message value
   * @return the corresponding enum instance
   */
  public <T extends Enum<T>> T getEnumInstance(Locale locale, Class<T> classz, String messageValue);

}
